Class ScriptValueImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.ScriptValueImpl
All Implemented Interfaces:
IPCObject, ScriptValue

public class ScriptValueImpl extends IPCObjectImpl implements ScriptValue
Information provided by the PKI file:

    \class ScriptValue
    
    \brief ScriptValue provides functionality to convert this script Engines values to basic types.
    
    \example appWindow().getActiveFile().getScriptEngine().createScriptValueInt(1)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • isBoolean

      public boolean isBoolean()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a boolean, otherwise false.
          
          \return bool, true if this ScriptValue is a boolean, otherwise false.
          
              
      Specified by:
      isBoolean in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isFunction

      public boolean isFunction()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a function, otherwise false.
          
          \return bool, true if this ScriptValue is a function, otherwise false.
          
              
      Specified by:
      isFunction in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isNull

      public boolean isNull()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is null, otherwise false.
          
          \return bool, true if this ScriptValue is null, otherwise false.
          
              
      Specified by:
      isNull in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isNumber

      public boolean isNumber()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a number, otherwise false.
          
          \return bool, true if this ScriptValue is a number, otherwise false.
          
              
      Specified by:
      isNumber in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isObject

      public boolean isObject()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an object, otherwise false.
          
          \return bool, true if this ScriptValue is an object, otherwise false.
          
              
      Specified by:
      isObject in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isUndefined

      public boolean isUndefined()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is undefined, otherwise false.
          
          \return bool, true if this ScriptValue is undefined, otherwise false.
          
              
      Specified by:
      isUndefined in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isValid

      public boolean isValid()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is valid, otherwise false.
          
          \return bool, true if this ScriptValue is valid, otherwise false.
          
              
      Specified by:
      isValid in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isString

      public boolean isString()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a string, otherwise false.
          
          \return bool, true if this ScriptValue is a string, otherwise false.
          
              
      Specified by:
      isString in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isError

      public boolean isError()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an error, otherwise false.
          
          \return bool, true if this ScriptValue is an error, otherwise false.
          
              
      Specified by:
      isError in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • isArray

      public boolean isArray()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an array, otherwise false.
          
          \return bool, true if this ScriptValue is an array, otherwise false.
          
              
      Specified by:
      isArray in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • property

      public ScriptValue property(String name)
      Information provided by the PKI file:
      
          \brief Returns the specified property.
          
          \param name, the name of the property of interest.
          
          \return ScriptValue, the ScriptValue object of the specified property.
          
              
      Specified by:
      property in interface ScriptValue
      Parameters:
      name - Takes in a parameter of name
      Returns:
      ScriptValue Returns a ScriptValue
    • toBoolean

      public boolean toBoolean()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to a boolean.
          
          \return bool, the value of the converted ScriptValue.
          
              
      Specified by:
      toBoolean in interface ScriptValue
      Returns:
      boolean Returns a boolean
    • toInt32

      public int toInt32()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to an integer.
          
          \return int, the value of the converted ScriptValue.
          
              
      Specified by:
      toInt32 in interface ScriptValue
      Returns:
      int Returns a int
    • toString

      public String toString()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to a QString.
          
          \return QString, the value of the converted ScriptValue.
          
              
      Specified by:
      toString in interface ScriptValue
      Overrides:
      toString in class Object
      Returns:
      String Returns a String